Public Class JsonSetterConverter As AbstractJsonFunctionConverter

Code Sample

• %REM
  The following code is in sample1 of deser-50.txt. When processing the firstName label in the JSON object, the JsonSetterConverter will be used to call the setName sub, passing the current value (the first name) as the first parameter and the lastName, a sibling of the firstName element in the JSON object, as the second parameter.
  %END REM
  Dim jsonObj as JsonObject  'populate accordingly
  Dim converter as New JsonSetterConverter
  Dim mainHolder as New Person()
  Call converter.forSetter("setName").withValueParam().withSiblingParam("lastName")
  Dim helper as New JsonConversionHelper()
  Call helper.withCustomConverter("firstName", converter)
  Call converter.deserialize(mainHolder, jsonObj)

Methods Detail

• forSetter

  Public Function forSetter(setterName As String) As JsonSetterConverter
  Passes the setter name to look for in the relevant class
  idx	Argument	Data Type	Attributes	Comments
  1	setterName	String		Sub or function in the target class
  Code Sample
  %REM The following code is in sample1 of deser-50.txt. When processing the firstName label in the JSON object, the JsonSetterConverter will be used to call the setName sub, passing the current value (the first name) as the first parameter and the lastName, a sibling of the firstName element in the JSON object, as the second parameter. %END REM Dim jsonObj as JsonObject 'populate accordingly Dim converter as New JsonSetterConverter Dim mainHolder as New Person() Call converter.forSetter("setName").withValueParam().withSiblingParam("lastName") Dim helper as New JsonConversionHelper() Call helper.withCustomConverter("firstName", converter) Call converter.deserialize(mainHolder, jsonObj)

• withSiblingParam

  Public Function withSiblingParam(labelName As String, defaultValue As Variant) As JsonSetterConverter
  Fluent method to retrieve a parameter value fr the setter from the JSON object, or a default value to use if the label is not in the JSON object. The relevant value is passed as the nth parameter to pass to the relevant setter.
  idx	Argument	Data Type	Attributes	Comments
  1	labelName	String		Label to search for at the same level as the JSON object being parsed
  2	defaultValue	Variant		Default to use if the label is not found in the JSON
  Code Sample
  %REM The following code is in sample1 of deser-50.txt. When processing the firstName label in the JSON object, the JsonSetterConverter will be used to call the setName sub, passing the current value (the first name) as the first parameter and the lastName, a sibling of the firstName element in the JSON object, as the second parameter. %END REM Dim jsonObj as JsonObject 'populate accordingly Dim converter as New JsonSetterConverter Dim mainHolder as New Person() Call converter.forSetter("setName").withValueParam().withSiblingParam("lastName", "") Dim helper as New JsonConversionHelper() Call helper.withCustomConverter("firstName", converter) Call converter.deserialize(mainHolder, jsonObj)

• withValueParam

  Public Function withValueParam() As JsonSetterConverter
  Uses the scalar value of the JSON element the converter is associated with. The value will be added to the end of the params array, as the nth parameter to pass to the relevant setter.
  Code Sample
  %REM The following code is from deser-50.txt. It deserializes a JSON object that contains firstName and lastName properties. During the deserialization it calls Laureate.setName(firstName as String, lastName as String). To do this, it uses a JsonSetterConverter tied to the firstName property, so withValueParam picks up that property. %END REM Dim json as String Dim helper as new JsonConversionHelper() Dim setterConverter as New JsonSetterConverter() Dim json as |{"firstname":"Guglielmo", "surname":"Marconi", "share": 2}| Call setterConverter.forSetter("setName")._ withValueParam()._ withSiblingParam("surname", "") Call helper.withCustomCnverter("firstName", setterConverter)

• deserialize

  Public Sub deserialize(holder As JsonConversionHolder, source As JsonObject)
  Overridden function.
  idx	Argument	Data Type	Attributes	Comments
  1	holder	JsonConversionHolder		Object to deserialize to
  2	source	JsonObject		JSON object to deserialize from
  Code Sample
  %REM The following code is in sample1 of deser-50.txt. When processing the firstName label in the JSON object, the JsonSetterConverter will be used to call the setName sub, passing the current value (the first name) as the first parameter and the lastName, a sibling of the firstName element in the JSON object, as the second parameter. %END REM Dim jsonObj as JsonObject 'populate accordingly Dim converter as New JsonSetterConverter Dim mainHolder as New Person() Call converter.forSetter("setName").withValueParam().withSiblingParam("lastName") Dim helper as New JsonConversionHelper() Call helper.withCustomConverter("firstName", converter) Call converter.deserialize(mainHolder, jsonObj)

• New

  Public Sub New()

• serialize

  Public Sub serialize(source As Variant, target As JsonObject)
  Overridden function, throws error
  idx	Argument	Data Type	Attributes	Comments
  1	source	Variant		VoltScript object from which to serialize
  2	target	JsonObject		JsonObject to write value to
  Throws Exceptions
  Message	Error Code	Comments
  JsonSettersConverters can only be used for deserialization	1400